Skip to content

Autodoc for the API #134

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 14 commits into from
Oct 17, 2019
Merged

Autodoc for the API #134

merged 14 commits into from
Oct 17, 2019

Conversation

emmanuelle
Copy link
Contributor

This is a very WIP PR, open here for discussion.

To do

  • decide which functions / classes are to be added to the __all__ of submodules, and how to populate __all__ (using the codegen for graph_objects? Ping @jonmmease )
  • add this doc build to the Makefile so that the CI can generate it
  • QA on theme and a few sentences of introduction

@nicolaskruchten
Copy link
Contributor

nicolaskruchten commented Oct 5, 2019 •
edited
Loading

plotly/plotly.py#1802 ideally handles the required __all__ in graph_objects

This was referenced Oct 6, 2019
Merged
Closed
@emmanuelle
Copy link
Contributor Author

Also, do we want to document submodules of modules? For the submodules of graph_objects I added them since we refer to objects in submodules. By the way, it would be great to use the :class:class_name syntax in docstrings so that sphinx can create links.

@nicolaskruchten
Copy link
Contributor

do we want to document submodules of modules?

Yes I think so!

it would be great to use the :class:class_name syntax

Hmmm yes... Is there a way to coax Sphinx into recognizing the existing . format?

@emmanuelle
Copy link
Contributor Author

I've looked into the subsubmodule thing and it will require hacking a template for this, so maybe we don't want this to hold us back.

@emmanuelle
Copy link
Contributor Author

For the review the html pages are available in CircleCI artifacts

@emmanuelle emmanuelle changed the title [WIP] Autodoc for the API Autodoc for the API Oct 17, 2019
@emmanuelle
Copy link
Contributor Author

I think this is now ready for review with the CI part. In the config.yml should I replace the test for master with this apidoc branch so that we can check that it is deployed correctly?

@emmanuelle emmanuelle merged commit db09d20 into master Oct 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@emmanuelle @nicolaskruchten